home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cato / Xm / XmFrame.z / XmFrame
Encoding:
Text File  |  2002-10-03  |  21.3 KB  |  331 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))               UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV               XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmFFFFrrrraaaammmmeeee - The Frame widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////FFFFrrrraaaammmmeeee....hhhh>>>>
  13.  
  14.  
  15.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  16.           This page documents version 1.2 of the Motif library.
  17.  
  18.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.           Frame is a very simple manager used to enclose a single work
  20.           area child in a border drawn by Frame.  It uses the Manager
  21.           class resources for border drawing and performs geometry
  22.           management so that its size always matches its child's outer
  23.           size plus the Frame's margins and shadow thickness.
  24.  
  25.           Frame is most often used to enclose other managers when the
  26.           application developer desires the manager to have the same
  27.           border appearance as the primitive widgets.  Frame can also
  28.           be used to enclose primitive widgets that do not support the
  29.           same type of border drawing.  This gives visual consistency
  30.           when you develop applications using diverse widget sets.
  31.           Constraint resources are used to designate a child as the
  32.           Frame title, align its text, and control its vertical
  33.           alignment in relation to Frame's top shadow.  The title
  34.           appears only at the top of the Frame.
  35.  
  36.           If the Frame's parent is a Shell widget, XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTTyyyyppppeeee
  37.           defaults to XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____OOOOUUUUTTTT, and Manager's resource
  38.           XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss defaults to 1.
  39.  
  40.           If the Frame's parent is not a Shell widget, XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTTyyyyppppeeee
  41.           defaults to XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____IIIINNNN, and Manager's resource
  42.           XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss defaults to 2.
  43.  
  44.         CCCCllllaaaasssssssseeeessss
  45.           Frame inherits behavior and resources from the CCCCoooorrrreeee,
  46.           CCCCoooommmmppppoooossssiiiitttteeee, CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt, and XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr classes.
  47.  
  48.           The class pointer is xxxxmmmmFFFFrrrraaaammmmeeeeWWWWiiiiddddggggeeeettttCCCCllllaaaassssssss.
  49.  
  50.           The class name is XXXXmmmmFFFFrrrraaaammmmeeee.
  51.  
  52.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  53.           The following table defines a set of widget resources used
  54.           by the programmer to specify data.  The programmer can also
  55.           set the resource values for the inherited classes to set
  56.           attributes for this widget.  To reference a resource by name
  57.           or by class in a .Xdefaults file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  58.           prefix and use the remaining letters.  To specify one of the
  59.           defined values for a resource in a .Xdefaults file, remove
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))               UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV               XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))
  71.  
  72.  
  73.  
  74.           the XXXXmmmm prefix and use the remaining letters (in either
  75.           lowercase or uppercase, but include any underscores between
  76.           words).  The codes in the access column indicate if the
  77.           given resource can be set at creation time (C), set by using
  78.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  79.           not applicable (N/A).
  80.  
  81.                               XXXXmmmmFFFFrrrraaaammmmeeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  82.       NNNNaaaammmmeeee              CCCCllllaaaassssssss             TTTTyyyyppppeeee            DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  83.       ____________________________________________________________________
  84.       XmNmarginWidth    XmCMarginWidth    Dimension       0         CSG
  85.       XmNmarginHeight   XmCMarginHeight   Dimension       0         CSG
  86.       XmNshadowType     XmCShadowType     unsigned char   dynamic   CSG
  87.  
  88.  
  89.           XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnWWWWiiiiddddtttthhhh
  90.                     Specifies the padding space on the left and right
  91.                     sides between Frame's child and Frame's shadow
  92.                     drawing.
  93.  
  94.           XXXXmmmmNNNNmmmmaaaarrrrggggiiiinnnnHHHHeeeeiiiigggghhhhtttt
  95.                     Specifies the padding space on the top and bottom
  96.                     sides between Frame's child and Frame's shadow
  97.                     drawing.  When a title is present, the top margin
  98.                     equals the value specified by this resource plus
  99.                     the distance (if any) that the title extends below
  100.                     the top shadow.
  101.  
  102.           XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTTyyyyppppeeee
  103.                     Describes the drawing style for Frame.  This
  104.                     resource can have the following values:
  105.  
  106.  
  107.                       +o  XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____IIIINNNN-draws Frame so that it appears
  108.                          inset.  This means that the bottom shadow
  109.                          visuals and top shadow visuals are reversed.
  110.  
  111.                       +o  XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____OOOOUUUUTTTT-draws Frame so that it appears
  112.                          outset.  This is the default if Frame's
  113.                          parent is a Shell widget.
  114.  
  115.                       +o  XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____IIIINNNN-draws Frame using a double
  116.                          line giving the effect of a line etched into
  117.                          the window.  The thickness of the double line
  118.                          is equal to the value of XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss.
  119.                          This is the default when Frame's parent is
  120.                          not a Shell widget.
  121.  
  122.                       +o  XXXXmmmmSSSSHHHHAAAADDDDOOOOWWWW____EEEETTTTCCCCHHHHEEEEDDDD____OOOOUUUUTTTT-draws Frame using a
  123.                          double line giving the effect of a line
  124.                          coming out of the window.  The thickness of
  125.                          the double line is equal to the value of
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))               UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV               XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))
  137.  
  138.  
  139.  
  140.                          XXXXmmmmNNNNsssshhhhaaaaddddoooowwwwTTTThhhhiiiicccckkkknnnneeeessssssss.
  141.  
  142.  
  143.                                            XXXXmmmmFFFFrrrraaaammmmeeee CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  144.      NNNNaaaammmmeeee                          CCCCllllaaaassssssss                         TTTTyyyyppppeeee            DDDDeeeeffffaaaauuuulllltttt                  AAAAcccccccceeeessssssss
  145.      ___________________________________________________________________________________________________________
  146.      XmNchildType                  XmCChildType                  unsigned char   XmFRAME_WORKAREA_CHILD   CSG
  147.      XmNchildHorizontalAlignment   XmCChildHorizontalAlignment   unsigned char   XmALIGNMENT_BEGINNING    CSG
  148.      XmNchildHorizontalSpacing     XmCChildHorizontalSpacing     Dimension       dynamic                  CSG
  149.      XmNchildVerticalAlignment     XmCChildVerticalAlignment     unsigned char   XmALIGNMENT_CENTER       CSG
  150.  
  151.  
  152.           XXXXmmmmNNNNcccchhhhiiiillllddddTTTTyyyyppppeeee
  153.                     Specifies whether a child is a title or work area.
  154.                     Frame supports a single title and/or work area
  155.                     child.  The possible values are:
  156.  
  157.  
  158.                       +o  XXXXmmmmFFFFRRRRAAAAMMMMEEEE____TTTTIIIITTTTLLLLEEEE____CCCCHHHHIIIILLLLDDDD
  159.  
  160.                       +o  XXXXmmmmFFFFRRRRAAAAMMMMEEEE____WWWWOOOORRRRKKKKAAAARRRREEEEAAAA____CCCCHHHHIIIILLLLDDDD
  161.  
  162.                       +o  XXXXmmmmFFFFRRRRAAAAMMMMEEEE____GGGGEEEENNNNEEEERRRRIIIICCCC____CCCCHHHHIIIILLLLDDDD
  163.  
  164.                          The Frame geometry manager ignores any child
  165.                          of type XXXXmmmmFFFFRRRRAAAAMMMMEEEE____GGGGEEEENNNNEEEERRRRIIIICCCC____CCCCHHHHIIIILLLLDDDD.
  166.  
  167.  
  168.           XXXXmmmmNNNNcccchhhhiiiillllddddHHHHoooorrrriiiizzzzoooonnnnttttaaaallllAAAAlllliiiiggggnnnnmmmmeeeennnntttt
  169.                     Specifies the alignment of the title.  This
  170.                     resource has the following values:
  171.  
  172.  
  173.                       +o  XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____BBBBEEEEGGGGIIIINNNNNNNNIIIINNNNGGGG
  174.  
  175.                       +o  XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____CCCCEEEENNNNTTTTEEEERRRR
  176.  
  177.                       +o  XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____EEEENNNNDDDD
  178.  
  179.                          See the description of  XXXXmmmmNNNNaaaalllliiiiggggnnnnmmmmeeeennnntttt in the
  180.                          XXXXmmmmLLLLaaaabbbbeeeellll man page for an explanation of these
  181.                          values.
  182.  
  183.  
  184.           XXXXmmmmNNNNcccchhhhiiiillllddddHHHHoooorrrriiiizzzzoooonnnnttttaaaallllSSSSppppaaaacccciiiinnnngggg
  185.                     Specifies the minimum distance between either edge
  186.                     of the title text and the inner edge of the Frame
  187.                     shadow.  Clipping of the title text occurs in
  188.                     order to maintain this spacing.  The default value
  189.                     is the margin width of the Frame.
  190.  
  191.           XXXXmmmmNNNNcccchhhhiiiillllddddVVVVeeeerrrrttttiiiiccccaaaallllAAAAlllliiiiggggnnnnmmmmeeeennnntttt
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))               UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV               XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))
  203.  
  204.  
  205.  
  206.                     Specifies the vertical alignment of the title
  207.                     text, or the title area in relation to the top
  208.                     shadow of the Frame.
  209.  
  210.  
  211.                       +o  XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____BBBBAAAASSSSEEEELLLLIIIINNNNEEEE____BBBBOOOOTTTTTTTTOOOOMMMM-causes the
  212.                          baseline of the title to align vertically
  213.                          with the top shadow of the Frame.  In the
  214.                          case of a multi-line title, the baseline of
  215.                          the last line of text aligns vertically with
  216.                          the top shadow of the Frame.
  217.  
  218.                       +o  XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____BBBBAAAASSSSEEEELLLLIIIINNNNEEEE____TTTTOOOOPPPP-causes the baseline
  219.                          of the first line of the title to align
  220.                          vertically with the top shadow of the Frame.
  221.  
  222.                       +o  XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____WWWWIIIIDDDDGGGGEEEETTTT____TTTTOOOOPPPP-causes the top edge of
  223.                          the title area to align vertically with the
  224.                          top shadow of the Frame.
  225.  
  226.                       +o  XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____CCCCEEEENNNNTTTTEEEERRRR-causes the center of the
  227.                          title area to align vertically with the top
  228.                          shadow of the Frame.
  229.  
  230.                       +o  XXXXmmmmAAAALLLLIIIIGGGGNNNNMMMMEEEENNNNTTTT____WWWWIIIIDDDDGGGGEEEETTTT____BBBBOOOOTTTTTTTTOOOOMMMM-causes the bottom
  231.                          edge of the title area to align vertically
  232.                          with the top shadow of the Frame.
  233.  
  234.  
  235.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  236.           Frame inherits behavior and resources from the following
  237.           superclasses.  For a complete description of each resource,
  238.           refer to the man page for that superclass.
  239.  
  240.                                           XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  241.      NNNNaaaammmmeeee                    CCCCllllaaaassssssss                   TTTTyyyyppppeeee                DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  242.      _________________________________________________________________________________________________
  243.      XmNbottomShadowColor    XmCBottomShadowColor    Pixel               dynamic                CSG
  244.      XmNbottomShadowPixmap   XmCBottomShadowPixmap   Pixmap              XmUNSPECIFIED_PIXMAP   CSG
  245.      XmNforeground           XmCForeground           Pixel               dynamic                CSG
  246.      XmNhelpCallback         XmCCallback             XtCallbackList      NULL                   C
  247.      XmNhighlightColor       XmCHighlightColor       Pixel               dynamic                CSG
  248.      XmNhighlightPixmap      XmCHighlightPixmap      Pixmap              dynamic                CSG
  249.      XmNinitialFocus         XmCInitialFocus         Widget              NULL                   CSG
  250.      XmNnavigationType       XmCNavigationType       XmNavigationType    XmTAB_GROUP            CSG
  251.      XmNshadowThickness      XmCShadowThickness      Dimension           dynamic                CSG
  252.      XmNstringDirection      XmCStringDirection      XmStringDirection   dynamic                CG
  253.      XmNtopShadowColor       XmCTopShadowColor       Pixel               dynamic                CSG
  254.      XmNtopShadowPixmap      XmCTopShadowPixmap      Pixmap              dynamic                CSG
  255.      XmNtraversalOn          XmCTraversalOn          Boolean             True                   CSG
  256.  
  257.  
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 4/30/98)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))               UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV               XXXXmmmmFFFFrrrraaaammmmeeee((((3333XXXX))))
  269.  
  270.  
  271.  
  272.      XmNunitType             XmCUnitType             unsigned char       dynamic                CSG
  273.      XmNuserData             XmCUserData             XtPointer           NULL                   CSG
  274.  
  275.                              CCCCoooommmmppppoooossssiiiitttteeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  276.      NNNNaaaammmmeeee                CCCCllllaaaassssssss               TTTTyyyyppppeeee          DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  277.      ______________________________________________________________________
  278.      XmNchildren         XmCReadOnly         WidgetList    NULL      G
  279.      XmNinsertPosition   XmCInsertPosition   XtOrderProc   NULL      CSG
  280.      XmNnumChildren      XmCReadOnly         Cardinal      0         G
  281.  
  282.                                                    CCCCoooorrrreeee RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  283.      NNNNaaaammmmeeee                            CCCCllllaaaassssssss                           TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt                AAAAcccccccceeeessssssss
  284.      ______________________________________________________________________________________________________________
  285.      XmNaccelerators                 XmCAccelerators                 XtAccelerators   dynamic                CSG
  286.      XmNancestorSensitive            XmCSensitive                    Boolean          dynamic                G
  287.      XmNbackground                   XmCBackground                   Pixel            dynamic                CSG
  288.      XmNbackgroundPixmap             XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  289.      XmNborderColor                  XmCBorderColor                  Pixel            XtDefaultForeground    CSG
  290.      XmNborderPixmap                 XmCPixmap                       Pixmap           XmUNSPECIFIED_PIXMAP   CSG
  291.      XmNborderWidth                  XmCBorderWidth                  Dimension        0                      CSG
  292.      XmNcolormap                     XmCColormap                     Colormap         dynamic                CG
  293.      XmNdepth                        XmCDepth                        int              dynamic                CG
  294.      XmNdestroyCallback              XmCCallback                     XtCallbackList   NULL                   C
  295.      XmNheight                       XmCHeight                       Dimension        dynamic                CSG
  296.      XmNinitialResourcesPersistent   XmCInitialResourcesPersistent   Boolean          True                   C
  297.      XmNmappedWhenManaged            XmCMappedWhenManaged            Boolean          True                   CSG
  298.      XmNscreen                       XmCScreen                       Screen *         dynamic                CG
  299.      XmNsensitive                    XmCSensitive                    Boolean          True                   CSG
  300.      XmNtranslations                 XmCTranslations                 XtTranslations   dynamic                CSG
  301.      XmNwidth                        XmCWidth                        Dimension        dynamic                CSG
  302.      XmNx                            XmCPosition                     Position         0                      CSG
  303.      XmNy                            XmCPosition                     Position         0                      CSG
  304.  
  305.         TTTTrrrraaaannnnssssllllaaaattttiiiioooonnnnssss
  306.           XmFrame inherits translations from XmManager.
  307.  
  308.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  309.           CCCCoooommmmppppoooossssiiiitttteeee((((3333XXXX)))), CCCCoooonnnnssssttttrrrraaaaiiiinnnntttt((((3333XXXX)))), CCCCoooorrrreeee((((3333XXXX)))), XXXXmmmmCCCCrrrreeeeaaaatttteeeeFFFFrrrraaaammmmeeee((((3333XXXX)))),
  310.           and XXXXmmmmMMMMaaaannnnaaaaggggeeeerrrr((((3333XXXX)))).
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 4/30/98)
  328.  
  329.  
  330.  
  331.